Get a product assessment by its id
GET/partner/v1.0/organizations/:organizationId/product-assessments/:id
Get a product assessment by its id
Request
Path Parameters
The ID of the organization in the Carbon Trail platform
The ID of the product assessment
Responses
- 200
OK
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
The unique identifier of the product assessment.
The unique identifier of the associated product.
product
object
Represents a product in the system.
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment, Furniture, Jewelry, Appliances, Toys, Home Furnishings, Consumer Electronics, Pet Care, Kitchenware & Tableware, Stationery, Office & Occasion, Lawn & Garden, Tools & Equipment, Building, Cleaning, Vehicle, Electrical Supplies, Beauty, Arts & Crafts, Plumbing & HVAC, Camping, Lighting, Safety & Security, Healthcare, Other Personal Accessories, General]
The category of the product.
Possible values: non-empty
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
Possible values: non-empty
The type of the component. Could be 'Fabric', 'Component' etc.
Possible values: non-empty
The unique identifier of the component For fabrics, this is the fabric ID.
amount
object
provenance
object
Possible values: [Gross, Net]
unit
object
provenance
object
loss
object
provenance
object
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
Possible values: non-empty
The type of the fabric component product. Equal to 'Fabric'.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
The durability constant of the product.
The percentage of deadstock for the product.
distributionDetails
object
Represents the distribution details for a product.
warehouses
object[]
nullable
The list of warehouses involved in the distribution process.
A unique identifier for the warehouse.
The sequence in transport of the warehouse across all warehouses.
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the warehouse.
retailStore
object
Represents a retail store.
A unique ID for the retail store
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the retail store.
channelDistributions
object[]
nullable
A list of channel-specific distribution details.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of returns for this channel, if applicable.
hops
object[]
nullable
A list of transport hops involved in the distribution process.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The percentage of products lost during distribution (e.g., due to damage or spoilage). Expressed as a decimal value (e.g., 0.02 for 2%).
saleDetails
object
The sale details for this product and assessment
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
channels
object[]
nullable
The sale details for each sale channel.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of sales made through the sale channel.
useDetails
object
Represents details about the use phase of a product.
The percentage of machine washing for the product.
The percentage of dry cleaning for the product.
The percentage of hand washing for the product.
The percentage of tumble drying for the product.
The percentage of ironing for the product.
The number of times the product is worn.
The frequency of washing the product.
The number of minutes spent ironing the product.
resources
object[]
nullable
The list of resources consumed during the product's use phase (e.g., electricity, water, fuel).
Only applicable for Toys and Appliances.
The type of resource consumed. Known values: "Electricity", "Water", "LPG", "Propane", "Charcoal", "Kerosene", "Natural Gas".
amount
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
duration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The wattage of the product during use (applicable to electrical products). Only applicable for Toys and Appliances.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
lifetime
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
endOfLifeDetails
object
The end of life details of the product lifecycle
productEndOfLife
object
Represents the end-of-life information for a product or packaging material.
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
packagingEndOfLife
object[]
nullable
The end of life details of the packaging materials used for this product
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
{
"id": "string",
"productId": "string",
"product": {
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"certifications": [
"string"
],
"facilityIds": {
"value": [
"string"
],
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
}
],
"accessories": [
{
"value": {
"type": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": "string",
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noAccessoriesUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"packaging": {
"materials": [
{
"value": {
"id": "string",
"material": "string",
"type": "Primary",
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noPackagingUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"excludedPackaging": [
"Primary"
]
},
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"intrinsicValue": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"amountType": "Gross",
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"loss": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"technology": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"lossPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"percentageShare": 0
}
],
"manufacturingLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"leftoverPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"noProcessUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"segment": "Sport",
"subSegment": "string",
"imageUrls": [
"string"
],
"recyclability": "Mostly Recyclable",
"sizing": {
"demographic": "string",
"size": "string"
},
"traits": [
"Reusable"
],
"repairInfo": {
"repairabilityMultiplier": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"availabilityOfSpareParts": true,
"availabilityOfRepair": true,
"areBasicRepairsFree": true,
"isRepairInformationAvailable": true
},
"productSellingPrice": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"gtiNs": [
"string"
]
},
"durabilityConstant": 0,
"deadstockPercentage": 0,
"distributionDetails": {
"warehouses": [
{
"id": "string",
"sequenceInTransport": 0,
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
}
],
"retailStore": {
"id": "string",
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
},
"channelDistributions": [
{
"channel": "D2C",
"returnPercentage": 0,
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
]
}
],
"distributionLoss": 0
},
"saleDetails": {
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"channels": [
{
"channel": "D2C",
"channelPercentage": 0
}
]
},
"useDetails": {
"machineWashingPercentage": 0,
"dryCleaningPercentage": 0,
"handWashingPercentage": 0,
"tumbleDryingPercentage": 0,
"ironingPercentage": 0,
"numberOfWears": 0,
"washingFrequency": 0,
"minutesSpentIroning": 0,
"resources": [
{
"type": "string",
"amount": {
"value": 0,
"unit": "string"
},
"duration": {
"value": 0,
"unit": "string"
}
}
],
"wattage": 0,
"usePerYear": {
"value": 0,
"unit": "string"
},
"lifetime": {
"value": 0,
"unit": "string"
}
},
"endOfLifeDetails": {
"productEndOfLife": {
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
},
"packagingEndOfLife": [
{
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
}
]
}
}
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
The unique identifier of the product assessment.
The unique identifier of the associated product.
product
object
Represents a product in the system.
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment, Furniture, Jewelry, Appliances, Toys, Home Furnishings, Consumer Electronics, Pet Care, Kitchenware & Tableware, Stationery, Office & Occasion, Lawn & Garden, Tools & Equipment, Building, Cleaning, Vehicle, Electrical Supplies, Beauty, Arts & Crafts, Plumbing & HVAC, Camping, Lighting, Safety & Security, Healthcare, Other Personal Accessories, General]
The category of the product.
Possible values: non-empty
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
Possible values: non-empty
The type of the component. Could be 'Fabric', 'Component' etc.
Possible values: non-empty
The unique identifier of the component For fabrics, this is the fabric ID.
amount
object
provenance
object
Possible values: [Gross, Net]
unit
object
provenance
object
loss
object
provenance
object
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
Possible values: non-empty
The type of the fabric component product. Equal to 'Fabric'.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
The durability constant of the product.
The percentage of deadstock for the product.
distributionDetails
object
Represents the distribution details for a product.
warehouses
object[]
nullable
The list of warehouses involved in the distribution process.
A unique identifier for the warehouse.
The sequence in transport of the warehouse across all warehouses.
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the warehouse.
retailStore
object
Represents a retail store.
A unique ID for the retail store
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the retail store.
channelDistributions
object[]
nullable
A list of channel-specific distribution details.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of returns for this channel, if applicable.
hops
object[]
nullable
A list of transport hops involved in the distribution process.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The percentage of products lost during distribution (e.g., due to damage or spoilage). Expressed as a decimal value (e.g., 0.02 for 2%).
saleDetails
object
The sale details for this product and assessment
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
channels
object[]
nullable
The sale details for each sale channel.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of sales made through the sale channel.
useDetails
object
Represents details about the use phase of a product.
The percentage of machine washing for the product.
The percentage of dry cleaning for the product.
The percentage of hand washing for the product.
The percentage of tumble drying for the product.
The percentage of ironing for the product.
The number of times the product is worn.
The frequency of washing the product.
The number of minutes spent ironing the product.
resources
object[]
nullable
The list of resources consumed during the product's use phase (e.g., electricity, water, fuel).
Only applicable for Toys and Appliances.
The type of resource consumed. Known values: "Electricity", "Water", "LPG", "Propane", "Charcoal", "Kerosene", "Natural Gas".
amount
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
duration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The wattage of the product during use (applicable to electrical products). Only applicable for Toys and Appliances.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
lifetime
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
endOfLifeDetails
object
The end of life details of the product lifecycle
productEndOfLife
object
Represents the end-of-life information for a product or packaging material.
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
packagingEndOfLife
object[]
nullable
The end of life details of the packaging materials used for this product
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
{
"id": "string",
"productId": "string",
"product": {
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"certifications": [
"string"
],
"facilityIds": {
"value": [
"string"
],
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
}
],
"accessories": [
{
"value": {
"type": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": "string",
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noAccessoriesUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"packaging": {
"materials": [
{
"value": {
"id": "string",
"material": "string",
"type": "Primary",
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noPackagingUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"excludedPackaging": [
"Primary"
]
},
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"intrinsicValue": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"amountType": "Gross",
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"loss": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"technology": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"lossPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"percentageShare": 0
}
],
"manufacturingLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"leftoverPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"noProcessUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"segment": "Sport",
"subSegment": "string",
"imageUrls": [
"string"
],
"recyclability": "Mostly Recyclable",
"sizing": {
"demographic": "string",
"size": "string"
},
"traits": [
"Reusable"
],
"repairInfo": {
"repairabilityMultiplier": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"availabilityOfSpareParts": true,
"availabilityOfRepair": true,
"areBasicRepairsFree": true,
"isRepairInformationAvailable": true
},
"productSellingPrice": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"gtiNs": [
"string"
]
},
"durabilityConstant": 0,
"deadstockPercentage": 0,
"distributionDetails": {
"warehouses": [
{
"id": "string",
"sequenceInTransport": 0,
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
}
],
"retailStore": {
"id": "string",
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
},
"channelDistributions": [
{
"channel": "D2C",
"returnPercentage": 0,
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
]
}
],
"distributionLoss": 0
},
"saleDetails": {
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"channels": [
{
"channel": "D2C",
"channelPercentage": 0
}
]
},
"useDetails": {
"machineWashingPercentage": 0,
"dryCleaningPercentage": 0,
"handWashingPercentage": 0,
"tumbleDryingPercentage": 0,
"ironingPercentage": 0,
"numberOfWears": 0,
"washingFrequency": 0,
"minutesSpentIroning": 0,
"resources": [
{
"type": "string",
"amount": {
"value": 0,
"unit": "string"
},
"duration": {
"value": 0,
"unit": "string"
}
}
],
"wattage": 0,
"usePerYear": {
"value": 0,
"unit": "string"
},
"lifetime": {
"value": 0,
"unit": "string"
}
},
"endOfLifeDetails": {
"productEndOfLife": {
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
},
"packagingEndOfLife": [
{
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
}
]
}
}
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- ComponentProduct
- FabricComponentProduct
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
- Fabric
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
The unique identifier of the product assessment.
The unique identifier of the associated product.
product
object
Represents a product in the system.
The unique identifier of the product.
The timestamp when the product was produced.
Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment, Furniture, Jewelry, Appliances, Toys, Home Furnishings, Consumer Electronics, Pet Care, Kitchenware & Tableware, Stationery, Office & Occasion, Lawn & Garden, Tools & Equipment, Building, Cleaning, Vehicle, Electrical Supplies, Beauty, Arts & Crafts, Plumbing & HVAC, Camping, Lighting, Safety & Security, Healthcare, Other Personal Accessories, General]
The category of the product.
Possible values: non-empty
The type of the product.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
components
object[]
nullable
The list of components that make up the product.
The unique identifier of the component.
Possible values: non-empty
The type of the component. Could be 'Fabric', 'Component' etc.
Possible values: non-empty
The unique identifier of the component For fabrics, this is the fabric ID.
amount
object
provenance
object
Possible values: [Gross, Net]
unit
object
provenance
object
loss
object
provenance
object
componentProduct
object
nullable
The detailed component product information for this component.
oneOf
Acts as a base for all component products.
Generic components use this directly
category
string
required
Possible values: [Fabric]
The category of the product.
Possible values: non-empty
The type of the fabric component product. Equal to 'Fabric'.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
Represents a fabric product entity, which is a specific type of component product.
category
string
required
Possible values: [Fabric]
The category of the product.
circular(FabricComponentProduct)
The unique identifier of the product.
The timestamp when the product was produced.
The timestamp when the product was created in the system.
The timestamp when the product was last updated.
The name of the product.
The article number of the product.
Possible values: non-empty
The Stock Keeping Unit (SKU) of the product.
materials
object[]
nullable
The list of raw materials used in the product.
Possible values: non-empty
The name of the raw material.
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The percentage of this material by weight in a component. For materials not used in a component, this is set to the weight distribution across the remainder of the product by weight.
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
hops
object[]
nullable
The list of transport hops for this raw material.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The list of certifications associated with this raw material.
facilityIds
object
provenance
object
accessories
object[]
nullable
The list of accessories associated with the product.
value
object
Represents an accessory/trim associated with a product.
Possible values: non-empty
The type of the accessory.
amount
object
provenance
object
unit
object
provenance
object
The unique identifier of the supplier for this accessory.
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
provenance
object
noAccessoriesUsed
object
provenance
object
packaging
object
The packaging material details of this product.
materials
object[]
nullable
The packaging materials used to pack this product.
value
object
Represents a packaging material used for a product.
A unique ID for this packaging material. Not required during product creation or when adding a new packaging material. The system generates an ID automatically. It is required to preserve existing packaging materials so it should be provided during product update flows.
Possible values: non-empty
The material used for packaging.
Possible values: [Primary, Secondary, Tertiary, Intermediate]
The type of packaging. Primary indicates the material the product is first wrapped with (like polybag) Secondary indicates the secondary layer on top of the primary layer (like cardboard) Tertiary indicates things like pallets which are used in warehouses.
weightInGms
object
provenance
object
supplierId
object
provenance
object
supplierLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
recyclingInformation
object
value
object
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
provenance
object
provenance
object
noPackagingUsed
object
provenance
object
Possible values: [Primary, Secondary, Tertiary, Intermediate]
weightInGms
object
provenance
object
intrinsicValue
object
provenance
object
The unique identifier of the organization associated with the product.
The unique identifier of the subsidiary associated with the product.
The list of certifications associated with the product.
Indicates whether the product is passport enabled.
Possible values: [Active, Snapshot, Draft, Submitted, Template]
The status of the entity in the Carbon Trail platform.
The list of components that make up the product.
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
Possible values: non-empty
The type of the component product.
The amount of the component product.
The unit of measurement for the component product.
The sub-type of the component product. Used for Accessory/Trim components where it helps indicate what is the common name of the accessory component for eg. 'Care label', 'Brand tag' etc.
fabricFormationType
object
Possible values: [Knit, Woven, Non-Woven]
The fabric formation type of a fabric.
provenance
object
yarnSizeValue
object
value
object
provenance
object
The printed surface area of the fabric
The printed surface area unit. Can be 'm2' which is meter-square or '%' which implies percentage of the fabric amount that is printed.
gsm
object
provenance
object
The list of hazardous substances associated with the product.
The cut-off date for the product data. After the cut-off date, no changes are allowed to the product.
The email of the user who submitted the product.
customFieldValues
object[]
nullable
The list of custom field values associated with the product.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
manufacturingDetails
object
Represents the manufacturing details of a product.
processes
object[]
nullable
The list of manufacturing processes involved in creating the product.
Possible values: non-empty
The name of the manufacturing process.
performed
object
required
provenance
object
technology
object
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
lossPercentage
object
provenance
object
The sequence number of this process in the overall manufacturing flow. Lower number implies the process is performed earlier. Starts from 1.
applicableSurfaceArea
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The percentage share of this process in the overall manufacturing. Useful for multi-sourcing scenarios where a process is performed in multiple factories.
manufacturingLocation
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
supplierId
object
provenance
object
facilityId
object
provenance
object
hops
object[]
nullable
The list of transport hops involved in the manufacturing.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
leftoverPercentage
object
provenance
object
noProcessUsed
object
provenance
object
Possible values: [Sport, Non-Sport, Delicates]
The market segment of a product, used to determine applicable durability and care parameters.
The sub-segment of the product, providing further classification within the segment. Valid values are: Bottoms, Tops, Leggings, Knit, Woven, Sheer, Classic thick, Infant/Baby, Children, Adult multipurpose with heel, Adult multipurpose without heel, Footwear for linear sports, Footwear for multidirectional sports, Footwear for outdoor sport, Footwear for water sports, Sport footwear with cleats, Sport slippers, Slipper/Indoor
The list of image URLs associated with the product.
Possible values: [Mostly Recyclable, Entirely Recyclable, Non Recyclable]
sizing
object
Represents the sizing information for a product, used to adjust product weight for LCA calculations.
The target demographic for the product sizing (can be "Infants", "Children (3-8 yr)", "Children (9-14 yr)", "Women", "Men", "Unisex")
The size label of the product (e.g., "S", "M", "L", "XL", "42", "10").
Possible values: [Reusable, Non-Reusable, Compostable, Non-Compostable, Remanufactured]
repairInfo
object
Represents repair-related attributes for a product, used in durability and environmental impact assessments.
repairabilityMultiplier
object
provenance
object
Whether spare parts are available in all locations (online or offline) or the product does not need spare parts. True if spare parts are available or not needed, false otherwise.
Whether repair services are available in all locations (online or offline). True if repair is available, false otherwise.
Whether basic repairs are offered at no extra cost. True if no extra cost for basic repairs, false otherwise.
Whether repair information is included during the sale and throughout the garment life. True if repair information is available, false otherwise.
productSellingPrice
object
value
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
provenance
object
The list of Global Trade Item Numbers (GTINs) for the product. GTINs are product identifiers used to look up product information in a database (often by scanning a barcode). They include UPCs, EANs, and ISBNs.
The durability constant of the product.
The percentage of deadstock for the product.
distributionDetails
object
Represents the distribution details for a product.
warehouses
object[]
nullable
The list of warehouses involved in the distribution process.
A unique identifier for the warehouse.
The sequence in transport of the warehouse across all warehouses.
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the warehouse.
retailStore
object
Represents a retail store.
A unique ID for the retail store
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
The floor surface area of the retail store.
channelDistributions
object[]
nullable
A list of channel-specific distribution details.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of returns for this channel, if applicable.
hops
object[]
nullable
A list of transport hops involved in the distribution process.
The ID of the source entity.
The ID of the destination entity.
legs
object[]
nullable
The individual transport legs between the source and destination.
value
object
An individual transport leg which represents the mode of transport, distance and utilization ratio.
utilizationRatio
object
provenance
object
distanceInKms
object
provenance
object
mode
object
Possible values: [Truck, Train, Van, Car, Barge, Ship, Plane]
Represents the mode of transport. ///
provenance
object
Optional fuel used by the transport mode.
Optional. Represents the % share this transport leg occupies across the entire transport hop. It is a value between 0 and 1. Only useful when filled in by the system in case of data gaps, not required for user input.
Optional. Represents the scope of the transport leg in the supply chain. Possible values are 'Local', 'Local (car)', 'Local (van)', 'Intracontinental', 'Intracontinental (barge)', 'Intracontinental (train)', 'Intracontinental (plane)','Intracontinental (truck)', 'International (ship)', 'International (plane)', 'International (train)'. Only useful when filled in by the system in case of data gaps, not required for user input.
provenance
object
The type of entity being transported. Support values "Fabric", "Component", "Process", "Packaging" etc.
The percentage of products lost during distribution (e.g., due to damage or spoilage). Expressed as a decimal value (e.g., 0.02 for 2%).
saleDetails
object
The sale details for this product and assessment
location
object
value
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
provenance
object
channels
object[]
nullable
The sale details for each sale channel.
Possible values: [D2C, E-Commerce, Retail Store, All Channels]
The types of sale channels
The percentage of sales made through the sale channel.
useDetails
object
Represents details about the use phase of a product.
The percentage of machine washing for the product.
The percentage of dry cleaning for the product.
The percentage of hand washing for the product.
The percentage of tumble drying for the product.
The percentage of ironing for the product.
The number of times the product is worn.
The frequency of washing the product.
The number of minutes spent ironing the product.
resources
object[]
nullable
The list of resources consumed during the product's use phase (e.g., electricity, water, fuel).
Only applicable for Toys and Appliances.
The type of resource consumed. Known values: "Electricity", "Water", "LPG", "Propane", "Charcoal", "Kerosene", "Natural Gas".
amount
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
duration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The wattage of the product during use (applicable to electrical products). Only applicable for Toys and Appliances.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
lifetime
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
endOfLifeDetails
object
The end of life details of the product lifecycle
productEndOfLife
object
Represents the end-of-life information for a product or packaging material.
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
packagingEndOfLife
object[]
nullable
The end of life details of the packaging materials used for this product
The unique identifier for the entity that this end of life info is for. Useful for packaging materials as it maps 1-1 with the ID of the packaging material in the product.
recyclingPathways
object
nullable
The recycling pathways that this product can take.
property name*
RecyclingInformation
nullable
Represents recycling information for a material.
recyclingPercentage
object
provenance
object
recyclingSource
object
provenance
object
recyclingCollection
object
Possible values: [Pre-Consumer, Post-Consumer]
The method of collecting the recycled material ///
provenance
object
recyclingProcess
object
Possible values: [Mechanical, Chemical, Chemical (Glycolysis), Chemical (Methanolysis)]
The method of processing the recycled material
provenance
object
The percentage of the product that goes to landfill.
The percentage of the product that is incinerated.
The percentage of the product that is reused.
{
"id": "string",
"productId": "string",
"product": {
"id": "string",
"productionTimestamp": "2024-07-29T15:51:28.071Z",
"category": "Apparel",
"type": "string",
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z",
"name": "string",
"articleNumber": "string",
"sku": "string",
"materials": [
{
"name": "string",
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"materialPercentageInComponent": 0,
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"certifications": [
"string"
],
"facilityIds": {
"value": [
"string"
],
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
}
],
"accessories": [
{
"value": {
"type": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": "string",
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noAccessoriesUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"packaging": {
"materials": [
{
"value": {
"id": "string",
"material": "string",
"type": "Primary",
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingInformation": {
"value": {
"recyclingPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingSource": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingCollection": {
"value": "Pre-Consumer",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"recyclingProcess": {
"value": "Mechanical",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"noPackagingUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"excludedPackaging": [
"Primary"
]
},
"weightInGms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"intrinsicValue": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"organizationId": "string",
"subsidiaryId": "string",
"certifications": [
"string"
],
"passportEnabled": true,
"status": "Active",
"components": [
{
"id": "string",
"type": "string",
"sku": "string",
"amount": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"amountType": "Gross",
"unit": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"loss": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"componentProduct": {}
}
],
"hazardousSubstances": [
"string"
],
"cutOffDate": "2024-07-29T15:51:28.071Z",
"submitterUserEmail": "string",
"customFieldValues": [
{},
null,
null,
null
],
"manufacturingDetails": {
"processes": [
{
"name": "string",
"performed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"technology": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"lossPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"flowSequenceNumber": 0,
"applicableSurfaceArea": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"percentageShare": 0
}
],
"manufacturingLocation": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"supplierId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"facilityId": {
"value": "string",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
],
"leftoverPercentage": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"noProcessUsed": {
"value": true,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
},
"segment": "Sport",
"subSegment": "string",
"imageUrls": [
"string"
],
"recyclability": "Mostly Recyclable",
"sizing": {
"demographic": "string",
"size": "string"
},
"traits": [
"Reusable"
],
"repairInfo": {
"repairabilityMultiplier": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"availabilityOfSpareParts": true,
"availabilityOfRepair": true,
"areBasicRepairsFree": true,
"isRepairInformationAvailable": true
},
"productSellingPrice": {
"value": {
"value": 0,
"unit": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"gtiNs": [
"string"
]
},
"durabilityConstant": 0,
"deadstockPercentage": 0,
"distributionDetails": {
"warehouses": [
{
"id": "string",
"sequenceInTransport": 0,
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
}
],
"retailStore": {
"id": "string",
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"areaInSquareMeters": 0
},
"channelDistributions": [
{
"channel": "D2C",
"returnPercentage": 0,
"hops": [
{
"sourceId": "string",
"destinationId": "string",
"legs": [
{
"value": {
"utilizationRatio": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"distanceInKms": {
"value": 0,
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"mode": {
"value": "Truck",
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"fuel": "string",
"provenance": 0,
"supplyChainLocation": "string"
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
}
],
"entity": "string"
}
]
}
],
"distributionLoss": 0
},
"saleDetails": {
"location": {
"value": {
"id": "loc-12345",
"city": "Paris",
"country": "FR",
"countryName": "France",
"continent": "Europe",
"latitude": 48.8566,
"longitude": 2.3522
},
"isDefault": true,
"provenance": {
"source": "string",
"notes": "string"
}
},
"channels": [
{
"channel": "D2C",
"channelPercentage": 0
}
]
},
"useDetails": {
"machineWashingPercentage": 0,
"dryCleaningPercentage": 0,
"handWashingPercentage": 0,
"tumbleDryingPercentage": 0,
"ironingPercentage": 0,
"numberOfWears": 0,
"washingFrequency": 0,
"minutesSpentIroning": 0,
"resources": [
{
"type": "string",
"amount": {
"value": 0,
"unit": "string"
},
"duration": {
"value": 0,
"unit": "string"
}
}
],
"wattage": 0,
"usePerYear": {
"value": 0,
"unit": "string"
},
"lifetime": {
"value": 0,
"unit": "string"
}
},
"endOfLifeDetails": {
"productEndOfLife": {
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
},
"packagingEndOfLife": [
{
"id": "string",
"recyclingPathways": {},
"landfillPercentage": 0,
"incinerationPercentage": 0,
"reusePercentage": 0
}
]
}
}